/*
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

/*
 *
 *
 *
 *
 *
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain, as explained at
 * http://creativecommons.org/publicdomain/zero/1.0/
 */

package java.util.concurrent;
import java.util.concurrent.locks.LockSupport;

/**
 * 可取消的异步计算
 * 该类提供了一个Future的基本实现
 * 1、启动和取消计算的方法
 * 2、查询计算是否完整
 * 3、检索计算结果,结果只能在计算完成后才能检索;
 * 4、如果计算尚未完成，则get方法将阻止。
 * 一旦计算完成，则无法重新启动或取消计算（除非使用runAndReset()调用计算 ）。
 * A FutureTask可用于包装Callable或Runnable对象。因为FutureTask实现Runnable ，一个FutureTask可以提交到一个Executor执行。
 * <p>
 * <p>
 * FutureTask中会涉及到两类线程:
 * 1、只有一个执行任务的线程,FutureTask的run方法就由该线程来执行。
 * 2、有多个获取任务执行结果的线程,这些线程可以并发执行，每一个线程都是独立的，都可以调用get方法来获取任务的执行结果
 * 如果任务还没有执行完，则这些线程就需要进入Treiber栈中挂起，直到任务执行结束，或者等待的线程自身被中断
 */
public class FutureTask<V> implements RunnableFuture<V> {

    // 当前任务运行状态
    /*
     * NEW -> COMPLETING -> NORMAL(正常结束，返回结果)
     * NEW -> COMPLETING -> EXCEPTIONAL(返回异常结果)
     * NEW -> CANCELLED(任务被取消，无结果)
     * NEW -> INTERRUPTING -> INTERRUPTED(任务被打断，无结果)
     * 任务的中间态并不代表任务正在执行,而是任务已经执行完了,正在设置最终的返回结果.
     * 只要state不处于 NEW 状态, 就说明任务已经执行完毕.
     */
    private static final int NEW = 0;          // 新建   0   初始状态
    private static final int COMPLETING = 1;   // 执行中 1    中间状态
    private static final int NORMAL = 2;       // 正常   2   最终态
    private static final int EXCEPTIONAL = 3;  // 异常   3   最终态
    private static final int CANCELLED = 4;    // 取消   4   最终态
    private static final int INTERRUPTING = 5; // 中断中  5  中间状态
    private static final int INTERRUPTED = 6;  // 被中断  6  最终态





   // 核心属性
    private volatile int state;        // 当前状态,volatile类型的确保了不同线程对它修改的可见性
    private Callable<V> callable;      // 将要被执行的任务
    private Object outcome;            // 存放执行结果,用于get()方法获取结果,也可能用于get()方法抛出异常
    private volatile Thread runner;    // 执行任务 Callable的线程
    private volatile WaitNode waiters; // 栈结构的等待队列,该节点是栈中最顶层的节点  单向链表结构





    // Unsafe mechanics,硬件级别的CAS原子操作
    /**
     * 1、最轻量级的锁
     * 2、多个线程尝试使用CAS同时更新同一个变量时,只有其中的一个线程能成功地更新变量的值,而其他的线程将失败。
     * 然而,失败的线程并不会被挂起
     * 3、CAS操作包含了三个操作数:
     *   a、需要读写的内存位置 b、进行比较的原值  c、拟写入的新值。
     */
    private static final sun.misc.Unsafe UNSAFE;
    // CAS操作主要针对3个属性，包括state、runner和waiters
    // 说明这3个属性基本是会被多个线程同时访问的
    private static final long stateOffset;
    private static final long runnerOffset;
    private static final long waitersOffset;

    static {
        try {
            UNSAFE = sun.misc.Unsafe.getUnsafe();
            Class<?> k = FutureTask.class;
            stateOffset = UNSAFE.objectFieldOffset
                    (k.getDeclaredField("state"));
            runnerOffset = UNSAFE.objectFieldOffset
                    (k.getDeclaredField("runner"));
            waitersOffset = UNSAFE.objectFieldOffset
                    (k.getDeclaredField("waiters"));
        } catch (Exception e) {
            throw new Error(e);
        }
    }


    // 构造函数
    /**
     * 创建一个 FutureTask ，它将在运行时执行给定的 Callable 。
     */
    public FutureTask(Callable<V> callable) {
        if (callable == null)
            throw new NullPointerException();
        this.callable = callable;
        this.state = NEW;
    }

    /**
     * 创建一个 FutureTask,将在运行时执行给定的 Runnable,并安排 get将在成功完成后返回给定的结果。
     *
     * @param runnable 可运行的任务
     * @param result   成功完成后返回的结果。 如果您不需要特定的结果，请考虑使用以下形式的结构：
     *                 {@code Future<?> f = new FutureTask<Void>(runnable, null)}
     * @throws NullPointerException 如果runnable为null
     */
    public FutureTask(Runnable runnable, V result) {
        this.callable = Executors.callable(runnable, result);
        this.state = NEW;
    }





    /**
     * run方法可以直接被调用,也可以开启新的线程调
     * 1、 run方法是没有返回值的，通过给outcome属性赋值（set(result)）,get时就能从outcome属性中拿到返回值
     * 2、 FutureTask两种构造器,最终都转化成了Callable
     *    所以在run()方法执行的时候,只需要执行Callable的call 方法即可
     *    在执行c.call()代码时
     *    如果入参是 Runnable的话,调用路径为 c.call() -> RunnableAdapter.call() -> Runnable.run()
     *    如果入参是 Callable 的话，直接调用
     */
    public void run() {
        // 状态不是任务新建
        // 或者当前任务已经有线程在执行了
        // 直接返回
        if (state != NEW ||
                !UNSAFE.compareAndSwapObject(this, runnerOffset,
                        null, Thread.currentThread()))
            return;
        try {
            Callable<V> c = callable;
            // Callable 不能为空,并且已经初始化完成
            // 判断 NEW 原因,在执行方法前; 若调用cancel方法,就会把任务取消掉了
            if (c != null && state == NEW) {
                V result;
                boolean ran;
                try {
                    result = c.call();
                    ran = true;         // 调用callable.call,执行成功
                } catch (Throwable ex) {
                    result = null;
                    ran = false;        // 调用callable.call,执行失败,抛异常
                    setException(ex);   // 通过CAS算法设置返回值(COMPLETING) -> 状态值(EXCEPTIONAL)
                }
                // 执行成功通过CAS(UNSAFE)设置返回值(COMPLETING) -> 状态值(NORMAL)
                if (ran)
                    set(result);        //将result赋值给outcome
            }
        } finally {
            runner = null;  // 将任务runner设置为null,避免发生并发调用run()方法
            int s = state;  // 须重新读取任务状态，避免不可达(泄漏)的中断
            if (s >= INTERRUPTING) // 确保cancle(ture)操作时，运行中的任务能接收到中断指令
                handlePossibleCancellationInterrupt(s);
        }
    }



    public boolean isCancelled() {
        // state == CANCELLED    == 4
        // state == INTERRUPTING == 5
        // state == INTERRUPTED  == 6
        // 当state为以上状态的时候,证明任务被取消或者被中断掉了
        return state >= CANCELLED;
    }

    public boolean isDone() {
        // 只要 state != NEW,说明任务正在进行了(进行中、已完成或者出现问题)
        // 完成可能是由于正常终止，异常或取消 - 在所有这些情况下，此方法将返回true
        return state != NEW;
    }



    /**
     * 取消此任务的执行。
     * @param mayInterruptIfRunning 如果为true，则尝试中断正在运行的任务，否则任务完成后将被取消。
     * @return 如果取消操作成功，则返回true；否则返回false。
     */
    public boolean cancel(boolean mayInterruptIfRunning) {

        /*
         * 以下三种情况,cancel操作一定失败
         *    1、任务已经执行完成了
         *    2、任务已经被取消过了
         *    3、任务因为某种原因不能被取消
         *
         * 以下两种状态转换
         *    1、NEW -> CANCELLED (对应于mayInterruptIfRunning=false)
         *    2、NEW -> INTERRUPTING -> INTERRUPTED (对应于mayInterruptIfRunning=true)
         *
         * cancel方法最终返回了true,
         * 但它只是简单的把state状态设为CANCELLED,并不会中断线程的执行。
         * 但是这样带来的后果是,任务即使执行完毕了,也无法设置任务的执行结果
         * 因为前面分析run方法的时候我们知道,设置任务结果有一个中间态,
         * 而这个中间态的设置,是以当前state状态为NEW为前提的。
         */

        // 此判断发生以下几种情况, 状态码不是NEW,说明任务已经开始启动了,就不能被取消了
        //  1、state == COMPLETING = 1;   // 执行中 1    中间状态
        //  2、state == NORMAL = 2;       // 正常   2   最终态
        //  3、state == EXCEPTIONAL = 3;  // 异常   3   最终态
        //  4、state == CANCELLED = 4;    // 取消   4   最终态
        //  5、state == INTERRUPTING = 5; // 中断中  5  中间状态
        //  6、state == INTERRUPTED = 6;  // 被中断  6  最终态
        //  7、CAS 失败
        if (!(state == NEW &&
                UNSAFE.compareAndSwapInt(this, stateOffset, NEW,
                        mayInterruptIfRunning ? INTERRUPTING : CANCELLED)))
            return false;
        try {
            // 防守性编程，以防调用中断时抛出异常
            // 如果允许中断且runner不为空，则尝试中断当前运行的线程
            if (mayInterruptIfRunning) {
                try {
                    Thread t = runner;
                    if (t != null)
                        t.interrupt();
                } finally { // 确保最终状态更新
                    UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED);
                }
            }
        } finally {
            finishCompletion();   // 完成取消过程的清理工作
        }
        /*
         * cancel操作返回true,并不代表任务就是被取消了.
         * 1、如果发起cancel时,任务还没有开始运行,则随后任务就不会被执行
         * 2、如果发起cancel时,任务已经运行了,则这时就需要看
         * mayInterruptIfRunning参数了：
         *     A、如果mayInterruptIfRunning 为true,  则当前在执行的任务会被中断
         *     B、如果mayInterruptIfRunning 为false, 则可以允许正在执行的任务继续运行，直到它执行完
         */
        return true;
    }




    /**
     * @throws CancellationException {@inheritDoc}
     */
    public V get() throws InterruptedException, ExecutionException {
        int s = state;
        if (s <= COMPLETING)
            // 当任务还没有执行完毕或者正在设置执行结果时
            // 我们就使用awaitDone方法等待任务进入终止态
            // 注意，awaitDone的返回值是任务的状态，而不是任务的结果。
            // 任务进入终止态之后，我们就根据任务的执行结果来返回计算结果或者抛出异常。
            s = awaitDone(false, 0L);
        return report(s);
    }

    /**
     * @throws CancellationException 如果计算被取消
     */
    public V get(long timeout, TimeUnit unit)
            throws InterruptedException, ExecutionException, TimeoutException {
        if (unit == null)
            throw new NullPointerException();
        int s = state;
        if (s <= COMPLETING &&
                (s = awaitDone(true, unit.toNanos(timeout))) <= COMPLETING)
            throw new TimeoutException();
        return report(s);
    }

    /**
     * Returns result or throws exception for completed task.
     *
     * @param s completed state value
     */
    @SuppressWarnings("unchecked")
    private V report(int s) throws ExecutionException {
        Object x = outcome;
        if (s == NORMAL)
            return (V) x;
        if (s >= CANCELLED)
            throw new CancellationException();
        throw new ExecutionException((Throwable) x);
    }

    /**
     * 当此任务转换到状态isDone （无论是正常还是通过取消）时调用的受保护方法。
     * 默认实现什么都不做。
     * 子类可以覆盖此方法来调用完成回调或执行簿记。
     * 请注意，您可以在执行此方法之前查询状态，以确定此任务是否已被取消。
     */
    protected void done() {
    }

    /**
     * 将此未来的结果设置为给定值，除非此未来已被设置或已被取消。 .
     * 1、内部调用 run()方法成功
     * @param v the value
     */
    protected void set(V v) {
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = v;
            UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
            finishCompletion();
        }
    }

    /**
     * 发生异常时，将返回值设置到outcome(=COMPLETING)中，并更新任务状态(EXCEPTIONAL)
     *  1、 内部调用 run()方法 失败
     *  2、 内部调用 runAndReset()方法 失败
     */
    protected void setException(Throwable t) {
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = t;
            UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
            finishCompletion();
        }
    }


    /**
     * 执行计算而不设置其结果，然后将此将来重置为初始状态，如果计算遇到异常或被取消，则不执行此操作。 这被设计用于内在地执行多次的任务。
     *
     * @return {@code true}如果成功运行和重置
     */
    protected boolean runAndReset() {
        if (state != NEW ||
                !UNSAFE.compareAndSwapObject(this, runnerOffset,
                        null, Thread.currentThread()))
            return false;
        boolean ran = false;
        int s = state;
        try {
            Callable<V> c = callable;
            if (c != null && s == NEW) {
                try {
                    c.call(); // don't set result
                    ran = true;
                } catch (Throwable ex) {
                    setException(ex);
                }
            }
        } finally {
            // runner must be non-null until state is settled to
            // prevent concurrent calls to run()
            runner = null;
            // state must be re-read after nulling runner to prevent
            // leaked interrupts
            s = state;
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
        return ran && s == NEW;
    }


    private void handlePossibleCancellationInterrupt(int s) {
        /*
         * 该方法是一个自旋操作。
         * 如果当前的state状态是INTERRUPTING，我们在原地自旋，直到state状态转换成终止态
         * 至此，run方法的分析就真的结束了
         */
        if (s == INTERRUPTING)
            while (state == INTERRUPTING)
                Thread.yield(); // wait out pending interrupt
    }


    static final class WaitNode {
        volatile Thread thread;
        volatile WaitNode next;

        WaitNode() {
            thread = Thread.currentThread();
        }
    }

    /**
     * FutureTask在高并发环境下确保任务只执行一次
     * 移除所有等待线程,并发出信息,调用done(),以及将任务Callable清空
     */
    private void finishCompletion() {
        /*
         * assert state > COMPLETING;
         * 该方法是将waiters属性的值由原值设置为null
         * 我们知道，waiters属性指向了Treiber栈的栈顶节点，可以说是代表了整个Treiber栈
         * 将该值设为null的目的就是清空整个栈。
         * 如果设置不成功，则if语句块不会被执行，又进行下一轮for循环，
         * 而下一轮for循环的判断条件又是waiters!=null ，
         * 由此我们知道，虽然最外层的for循环乍一看好像是什么遍历节点的操作，
         * 其实只是为了确保waiters属性被成功设置成null
         * 本质上相当于一个自旋操作。
         */
        for (WaitNode q; (q = waiters) != null; ) {
            if (UNSAFE.compareAndSwapObject(this, waitersOffset, q, null)) {
                // 循环唤醒阻塞线程,直到阻塞队列为空
                for (; ; ) {
                    Thread t = q.thread;
                    if (t != null) {
                        q.thread = null;
                        LockSupport.unpark(t);
                    }
                    WaitNode next = q.next;
                    if (next == null)
                        break;
                    q.next = null; // unlink to help gc
                    q = next;
                }
                break;
            }
        }

        done();

        callable = null;        // to reduce footprint
    }

    /**
     * 获取任务结果
     * 它完成了获取结果，挂起线程，响应中断等诸多操作
     * @param timed true 使用超时时间
     * @param nanos time to wait, if timed
     * @return state upon completion
     */
    private int awaitDone(boolean timed, long nanos)
            throws InterruptedException {
        final long deadline = timed ? System.nanoTime() + nanos : 0L;
        WaitNode q = null;
        boolean queued = false;

        // 自旋
        for (; ; ) {
            /*
             * 首先,检测当前线程是否被中断
             * 这是因为get方法阻塞式,如果等待的任务还没有执行完,
             * 则会调用get方法的线程会被扔到Treiber栈中挂起等待，直到任务执行完毕
             * 但是,如果任务迟迟没有执行完毕,则我们也有可能直接中断在Treiber栈中的线程，以停止等待
             */
            if (Thread.interrupted()) {
                removeWaiter(q);
                throw new InterruptedException();
            }

            int s = state;
            if (s > COMPLETING) {
                if (q != null)
                    q.thread = null;
                return s;
            } else if (s == COMPLETING) // cannot time out yet
                Thread.yield();
            else if (q == null)
                q = new WaitNode();
            else if (!queued)
                queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                        q.next = waiters, q);
            else if (timed) {
                nanos = deadline - System.nanoTime();
                if (nanos <= 0L) {
                    removeWaiter(q);
                    return state;
                }
                LockSupport.parkNanos(this, nanos);
            } else
                LockSupport.park(this);
        }
    }

    /**
     * 当检测到线程被中断后，我们调用了removeWaiter
     *
     * 将参数中node从等待队列(即Treiber栈)中移除。
     * 如果此时线程还没有进入Treiber栈,
     * 则 q=null,那么removeWaiter(q)啥也不干.在这之后，我们就直接抛出了InterruptedException异常。
     */
    private void removeWaiter(WaitNode node) {
        if (node != null) {
            node.thread = null;
            retry:
            for (; ; ) {          // restart on removeWaiter race
                for (WaitNode pred = null, q = waiters, s; q != null; q = s) {
                    s = q.next;
                    if (q.thread != null)
                        pred = q;
                    else if (pred != null) {
                        pred.next = s;
                        if (pred.thread == null) // check for race
                            continue retry;
                    } else if (!UNSAFE.compareAndSwapObject(this, waitersOffset,
                            q, s))
                        continue retry;
                }
                break;
            }
        }
    }



}
